home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / util / cli / into.lha / into.doc next >
Text File  |  1992-03-06  |  7KB  |  241 lines
  1. Docs for Into tool by Iain King
  2. Freely distibutable, and if you want you can send me stuff (anything nice)
  3.  
  4.    What INTO does is let you feed a pattern of files into a program,
  5. which is very handy for programs that do not support pattern matching 
  6. (I wanted this cause my sound player 'sound' doesnt).  Its also handy for
  7.  batch processing.  To use:
  8.  
  9.  
  10.    into PATTERN <options> | command <tags>
  11.  
  12. PATTERN is any dos standard pattern (#, ?, #?, ~, etc)
  13.  
  14. <options> - optional :), they are
  15.  
  16.    QUIET - INTO displays no output except for requesters
  17.    SILENT - same as QUIET plus any output from the command is redirected to
  18.             NIL:
  19.    INCINFO - includes .info files for processing
  20.    DIRS - only processes directories
  21.    FILES - only processes files
  22.    ALL - processes directories recursively       * very usefull!
  23.    QUIT=#
  24.  
  25.    lets you select quit mode.
  26.    By default you can't quit (sorry), but adding one of these will solve the
  27. prob:
  28.  
  29.    QUIT=1 means holding dowm both mouse buttons between jobs will quit
  30.    QUIT=2 means holding down the joystick firebutton between jobs quits
  31.  
  32.    mode 2 is best because it doesnt get muddled up with menus, then
  33. again - you cant play games :)
  34.    If your using mode 1 it seems to work better if you repeatedly press the
  35. buttons when you expect a job to finish. Sorry for it being kinda cack.
  36.  
  37.  
  38.    +CONFIRM - asks the user for confirmation on each job, <return>=yes
  39.    -CONFIRM - same as above but <return>=no
  40.  
  41.    n.b. for confirmations, y=yes, n=no, a=all (i.e. everything else), s=skip
  42.    (skips everything else)
  43.  
  44.    FILEKEY=###  sets the filekey tag to ###
  45.    QUERYKEY=### sets the querykey tag to ###
  46.  
  47.    these are to give greater flexibility for running commands (more later)
  48.  
  49.    FROM=###   make into get its list of names from the file ###
  50.                meaning you can create a list of files, like this one:
  51.  
  52. example file: name "flarp.list"
  53. ------snip------
  54. foo.iff
  55. bar.iff
  56. baz.iff
  57. quux.iff
  58. ------snip------
  59.  
  60.    INTO will use each of these files for jobs, ignoring the given pattern
  61.    this could be used for a slide=show, i.e.:
  62.  
  63.       INTO # FROM=flarp.list SILENT | vt
  64.  
  65.  
  66.      (Thanks to Daniele Carnino for reporting the bug in FROM)
  67.  
  68.  
  69.    HELP - small :) help text
  70.  
  71.    INCSPACES - this determines how files with spaces in there name are
  72.                handled: more on this in the tags section
  73.  
  74.    NOPATH - operates on the file name only - no path given
  75.  
  76.       i.e. for the match   :                 work:games/worms/wormsfile
  77.            using NOPATH will operate on :    wormsfile
  78.  
  79.    RELATIVE - filename operated on is given forwards relative to the current
  80.                directory.
  81.  
  82.       i.e. if the current dir is   :  work:temp/
  83.            and match is            :  work:temp/stuff/thisfile
  84.            then the filename used= :  stuff/thisfile
  85.  
  86.       NOTE:  only works forwards.  If you specify a PATTERN the refers to a 
  87.              directory either 'behind' or on a different device jiberish
  88.              will be returned : i.e.
  89.  
  90.           into /#? all relative | echo            ERROR!!!!!
  91.           into df0:#? all relative | echo         ERROR if current disk is
  92.                                                          not df0:
  93.  
  94.  
  95.  '|'
  96.  
  97.    this must be a on its own with a space on either side - denotes start of
  98. command.
  99.  
  100.  
  101.  
  102.    command
  103.  
  104.  
  105.    Any DOS command, and its arguments i.e.
  106.  
  107.       list dirs nohead
  108.  
  109.    If INTO finds one of the parameters to contain the file tag or a query
  110. tag then it:
  111.  
  112.    If it finds a file tag it inserts the current job at that point (handy
  113. for commands that are fidly for where you put a filename)
  114.  
  115.    If it finds a query tag it stops and asks the user for input, using the
  116. user input as parameters.
  117.  
  118. I.E.
  119.  using above example, you could set up:
  120.  
  121.    INTO # FROM=flarp.list FILEKEY=£££ QUERYKEY=$$$ | vt £££ $$$
  122.  
  123. this would respond with:
  124.  
  125. Working on file    foo.iff   : <user input>
  126.  
  127. you then type in any options specific to that file
  128. (fullscreen, window, whatever), it would then do
  129.  
  130. vt foo.iff fullscreen
  131.  
  132. and move onto the next file.  NOTE you can include the tags into other
  133. parameters:
  134.  
  135.    For instance, to back up every file in a directory to an equivalent
  136. backup file:
  137.  
  138.    INTO #? INCINFO FILEKEY=! | copy ! !.back
  139.  
  140. for a directory:
  141.  
  142. foo
  143. foo.info
  144. bar.iff
  145. bar.iff.info
  146.  
  147. would do
  148.  
  149. copy foo foo.back
  150. copy foo.info foo.info.back
  151. copy bar.iff bar.iff.back
  152. copy bar.iff.info bar.iff.info.back
  153.  
  154. To give the backups icons (ie, to put the .back extension before the .info
  155. extensions):
  156.  
  157.    INTO #? FILEKEY=$ | copy $ $.back
  158.  
  159.    INTO #? INCINFO FILEKEY=$ | copy $.info $.back.info
  160.  
  161. N.B.  If no FILEKEY is given then the file is appened to the end of the
  162. command.  If given it is only inserted expletively - only when you tell it
  163. to.
  164.  
  165.  
  166.    INCSPACES comes in here, for example:
  167.  
  168.    INTO #? DIRS FILEKEY=$ | LIST $/
  169.  
  170.    This would do a directory list of the contents of all the dirs in the cd.
  171. However, if the current dir had a space in it, say its name is "foo bar",
  172. then theis would result in:
  173.  
  174.    LIST "foo bar"/
  175.  
  176.    Which is not what you want.  This is where INCSPACES comes in.  If used
  177. then the quotes will extend to surround all the current argument:
  178.  
  179.  
  180.    INTO #? DIRS FILEKEY=$ INCSPACES | LIST $/
  181.  
  182. would result in:
  183.  
  184.    LIST "foo bar/"
  185.  
  186.  
  187.    perhaps the most powerful feature is the ability to move recursievly
  188. through directories:  Say you wanted to delete all backup (.bak) files on
  189. your hard disk:
  190.  
  191. doing a
  192.  
  193.          DELETE #?.bak all
  194.  
  195. does not work cause it wouldnt enter a directory unless it had a .bak
  196. extension - and then it would delete it !!!
  197.  
  198.    This would though
  199.  
  200.       INTO #? DIRS ALL FILEKEY=$$$ | INTO $$$/#?.bak +CONFIRM | DELETE
  201.  
  202. .  N.B., you dont need to use 2 INTOs, but this shows another use of
  203. INTO - you can add confirmation to commands.  The above could be done by:
  204.  
  205.       INTO #? DIRS ALL FILEKEY=$$$ | DELETE $$$/#?.bak
  206.  
  207. but using the second INTO means that every file is prompted before deletion.
  208.  
  209.  
  210.  
  211.    Some extra stuff:
  212.  
  213.       Disclaimer:  Sorry folks, but I cant and wont be held responsible for
  214. any damage INTO does.  It seems to work OK but it seemed to work very
  215. quickly with basically no bugs, so watch yerselves and let me know if you
  216. find any.  Also, watch out - it is a very powerful file tool and you
  217. could shoot yourself in the foot VERY easily ( the syntax is by nature
  218. baroque, and its a hell of a lot easier to kill files than a simple
  219. "delete #? all" mistake.
  220.  
  221.    Note - because of the Way It Works, (or rather my lazy programing) INTO
  222. can be quite RAM intensive.  You are warned.
  223.  
  224.    You can send me stuff (hey, I can ask cant I?) at :
  225.  
  226.          Blairs Croft
  227.          Creetown
  228.          Newton Stewart
  229.          DG8 7DF
  230.          Scotland
  231.  
  232.    Better still (unless your sending me money $-) or pressies) you can email
  233. me with bug reports or suggestions at:
  234.  
  235.    iking@cs.strath.ac.uk       - ill be here (Hopefully) till about the year
  236.                                  2000!!!
  237.  
  238.    Hope its handy
  239.  
  240.  
  241.